

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Generate RTF Documents [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Create,Create Rich Text Format Report (Enhanced Generator),Create RTF Report (Enhanced Generator),RTF Report,RTF Report Generate (Enhanced),RTF Report Generate, Quick Start,RTF Report Element-Level,RTF Report Quick Start,RTF Report Through Model Search,RTF Report Through Element List,Rich Text Format Report,Rich Text Format Report Generate (Enhanced),Rich Text Format Report Generate, Quick Start,Rich Text Format Report Element-Level,Rich Text Format Report Through Model Search,Rich Text Format Report Through Element List,Model Search,Model Search Generate RTF Report,Element List,Element List Generate RTF Report,Quick Start,Quick Start Generate RTF Report">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Generate RTF Documents</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="rtfdocuments.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="document_options.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">Creating a Rich Text Format (RTF) document is a simple and flexible process. An RTF document is based on a package or an element in your project (more usually a package). To produce a document, you must select the package or element to report on in the </span><span class="f_UIControl">Project Browser</span><span class="f_BodyText">, </span><span class="f_UIControl">Element List </span><span class="f_BodyText">or</span><span class="f_UIControl"> Model Search</span><span class="f_BodyText">.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Tip:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">Reports can be configured to include all packages within a parent package, or just the top level.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">You should also set the <a href="document_options.htm">diagram properties</a> to determine how the diagrams in the package are set out in the RTF document. When you have prepared and selected your package, use the context menu to open the </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_BodyText"> dialog and configure the details of your document. The next topic guides you through creating a rich text report.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Open the Generate RTF Documentation Dialog</span></p>
<p class="p_BodyText"><span class="f_BodyText">Use one of the following methods:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Select the </span><span class="f_MenuKeyField">Project | Documentation | Rich Text Format (RTF) Report</span><span class="f_Bulletlist1"> menu option</span></li>
<li><span class="f_Bulletlist1">In the </span><span class="f_UIControl">Project Browser</span><span class="f_Bulletlist1">, right-click on the required package and, on the context menu, select the </span><span class="f_MenuKeyField">Documentation | Rich Text Format (RTF) Report</span><span class="f_Bulletlist1"> menu option</span></li>
<li><span class="f_Bulletlist1">In the </span><span class="f_UIControl">Project Browser</span><span class="f_Bulletlist1"> or a diagram, click on the required package or element and press </span><span class="f_MenuKeyField">[F8]</span></li>
<li><span class="f_Bulletlist1">In a diagram, click on a specific element and select the</span><span class="f_MenuKeyField"> Element | Rich Text Format (RTF) Report</span><span class="f_Bulletlist1"> menu option</span></li>
<li><span class="f_Bulletlist1">In the </span><span class="f_UIControl">Element List </span><span class="f_Bulletlist1">or </span><span class="f_UIControl">Model</span><span class="f_Bulletlist1"> </span><span class="f_UIControl">Search</span><span class="f_Bulletlist1">, select one or more items, right-click and, from the context menu, select either the </span><span class="f_MenuKeyField">RTF Report | Generate report for each selected object</span><span class="f_Bulletlist1"> option or the </span><span class="f_MenuKeyField">RTF Report | Generate one report for all selected</span><span class="f_Bulletlist1"> option.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">See the </span><span class="f_BodyText" style="font-style: italic;"><a href="rtfdialogoptions.htm">Generate RTF Documentation Dialog</a></span><span class="f_BodyText"> topic for more information.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Quick Start</span></p>
<p class="p_BodyText"><span class="f_BodyText">To generate and view an example RTF report right now, follow the steps below:</span></p>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=1><span class="f_NumberedList">Open the </span><span class="f_NumberedList" style="font-style: italic;">EAExample</span><span class="f_NumberedList"> project.</span></li>
<li value=2><span class="f_NumberedList">Open the </span><span class="f_NumberedList" style="font-style: italic;">QA Model</span><span class="f_NumberedList"> package and right-click on the </span><span class="f_NumberedList" style="font-style: italic;">Testing</span><span class="f_NumberedList"> package.</span></li>
<li value=3><span class="f_NumberedList">Select the </span><span class="f_MenuKeyField">Documentation | Rich Text Format (RTF) Report </span><span class="f_NumberedList">context menu option. The </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_BodyText"> </span><span class="f_NumberedList">dialog displays.</span></li>
<li value=4><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Output to file</span><span class="f_NumberedList"> field, select a convenient file location in which to hold the generated report.</span></li>
<li value=5><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Use Template</span><span class="f_NumberedList"> field, click on the drop-down arrow and select </span><span class="f_MenuKeyField">(basic template)</span><span class="f_NumberedList">.</span></li>
<li value=6><span class="f_NumberedList">Click on the </span><span class="f_MenuKeyField">Generate</span><span class="f_NumberedList"> button.</span></li>
<li value=7><span class="f_NumberedList">When the report has been generated, click on the </span><span class="f_MenuKeyField">View</span><span class="f_NumberedList"> button.</span></li>
</ol>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Generate RTF Report From Element List or Model Search</span></p>
<p class="p_BodyText"><span class="f_BodyText">When you select to create an RTF Report from the </span><span class="f_UIControl"><a href="reportview.htm">Element List</a></span><span class="f_BodyText"> or </span><span class="f_UIControl"><a href="search_view.htm">Model Search</a></span><span class="f_BodyText"> tools, you can generate an element-level report rather than a package-level report, and you have additional flexibility in selecting:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">The type of element to report on</span></li>
<li><span class="f_Bulletlist1">The specific elements to report on, together or separately, whether in the same package or not.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">For example, you might want to find all elements with test cases, with the intention of reporting on some or possibly all such elements. With the </span><span class="f_UIControl">Element List</span><span class="f_BodyText">, you would identify these elements yourself within the list of all elements in a selected package, but with the </span><span class="f_UIControl">Model Search</span><span class="f_BodyText"> you could specifically identify the elements across a section of the model or across the whole model, as required. The search filtering could be for specific test cases; however, the results are by element so if there are test cases outside the range in any element that has a filtered test, these elements are listed as well.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Having generated the list of elements, you can select individual elements, blocks of elements, or all elements, and then (as above) use the context menu to generate a report on all of the elements, or separate reports on each element.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
